<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: pico_binary_info</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.1.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__pico__binary__info.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle"><div class="title">pico_binary_info<div class="ingroups"><a class="el" href="group__runtime.html">Runtime Infrastructure</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Binary info is intended for embedding machine readable information with the binary in FLASH.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga758f119659f2491c89e8e2955d647e9a"><td class="memItemLeft" align="right" valign="top"><a id="ga758f119659f2491c89e8e2955d647e9a" name="ga758f119659f2491c89e8e2955d647e9a"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>bi_decl</b>(_decl)&#160;&#160;&#160;__bi_mark_enclosure _decl; __bi_decl(__bi_ptr_lineno_var_name, &amp;__bi_lineno_var_name.core, &quot;.binary_info.keep.&quot;, __used);</td></tr>
<tr class="memdesc:ga758f119659f2491c89e8e2955d647e9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Declare some binary information that will be included if the contain source file/line is compiled into the binary. <br /></td></tr>
<tr class="separator:ga758f119659f2491c89e8e2955d647e9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga448b6eaeefd68be7031086e7dfcaf96e"><td class="memItemLeft" align="right" valign="top"><a id="ga448b6eaeefd68be7031086e7dfcaf96e" name="ga448b6eaeefd68be7031086e7dfcaf96e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>bi_decl_if_func_used</b>(_decl)&#160;&#160;&#160;({__bi_mark_enclosure _decl; __bi_decl(__bi_ptr_lineno_var_name, &amp;__bi_lineno_var_name.core, &quot;.binary_info.&quot;, ); *(const volatile uint8_t *)&amp;__bi_ptr_lineno_var_name;});</td></tr>
<tr class="memdesc:ga448b6eaeefd68be7031086e7dfcaf96e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Declare some binary information that will be included if the function containing the decl is linked into the binary. The SDK uses &ndash;gc-sections, so functions that are never called will be removed by the linker, and any associated binary information declared this way will also be stripped. <br /></td></tr>
<tr class="separator:ga448b6eaeefd68be7031086e7dfcaf96e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p >Binary info is intended for embedding machine readable information with the binary in FLASH. </p>
<p >Example uses include:</p>
<ul>
<li>Program identification / information</li>
<li>Pin layouts</li>
<li>Included features</li>
<li>Identifying flash regions used as block devices/storage </li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>